Repository navigation
Name the inputs of the stepped distance searches sectors, and the searches in the singular - #910
Merged
Merged
Conversation
…rches in the singular A joint search of the X and Z sectors of a CSS code is one problem with two sectors, so the stepped searches take `sectors` and their classes have singular names: `BrouwerZimmermannSearch`, `ConnectedClusterSearch`, and `_SectorSearch` for the BZ search of one sector. The BZ entry point loses its `_many` suffix. Behavior is unchanged. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Define a sector without "of one type", say in the BZ docstrings that each sector has a search, call the sector in a test docstring by its name, and bring benchmark.py's description of non-CSS searches in line with the README. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…he sector wording Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
#900 made the Brouwer-Zimmermann (BZ) and connected-cluster distance searches steppable objects, which take a list of inputs and advance one layer or weight limit at a time. It called those inputs
problemsand named the classes in the plural (BrouwerZimmermannSearches,ConnectedClusterSearches), as though a joint search of the X and Z sectors of a CSS code were several searches. But that joint search solves one problem, and the guides already call its parts sectors. This PR renames the inputs and classes to match, so that the code, its docstrings, and the guides use one vocabulary: a search solves one problem, made of one or more sectors.Changes
problemsbecomessectorsinget_distance_brouwer_zimmermann,BrouwerZimmermannSearch,get_distance_connected_cluster, andConnectedClusterSearch, with their docstrings and error messages ("Require at least one sector or an upper bound").BrouwerZimmermannSearchandConnectedClusterSearch. The BZ search of one sector,_BrouwerZimmermannSearch, becomes_SectorSearch, the function that prepares it becomes_prepare_sector_search, andget_distance_brouwer_zimmermann_manyloses its suffix.brouwer_zimmermann.mdandconnected_cluster.md,SupportSearch, and wording shared with coset searches.qldpc.codes.distanceadds that a search of a classical code, of a qubit code that is not CSS, or of a circuit examines one sector, andconnected_cluster.mdsays the same of classical codes and codes that are not CSS.docs/source/exact_search_tuning.rst, andexperiments/distance_tuning/trace.pyfollow the rename. The trace script's JSON events now name a"sector"field instead of"problem", andbenchmark.pyin the same directory now says that it searches a non-CSS code as one sector.All renamed objects are in private modules, so no deprecation is needed. Behavior is unchanged.
Validation
To confirm that the rename changes no search decision,
experiments/distance_tuning/trace.py --comparecompared the layer-by-layer decisions ofmainand this branch on ten workloads: BZ distances of CSS, non-CSS, and classical codes, a BZ logical count, and connected-cluster distances. All ten matched.